Introduction
This is the reference documentation for the nice_things framework. All public functions in every module and preprocessor macro are documented here.
You can find a list of all classes, modules, and macros on the left side of the screen, sorted by category.
You can press / (slash) on the keyboard or click the magnifying glass icon in the header at the top of the screen to search.
If you want to learn the basics of how to use the framework, check out the README file in the source-code repository.
Most modules contain a single public function or read-only variable with the same name as the module file, but a few modules may publish several functions/variables. To make it easier to find a function/variable by name, bellow is an index of all public names sorted alphabetically.
Index of public names
abortArray_destructorArray_getArray_includesArray_index_ofArray_lengthArray_popArray_pushArray_shiftArray_sliceArray_spliceArray_to_quotedArray_unshiftArrayassign_variableassignawait_all_raceawait_allawait_anyawait_firstawaitbasenamecatchcatcheck_referenceclass_shiftclasscloseConfig_destructorConfig_get_arrayConfig_get_stringConfigcontainscreate_objectcreate_runtime_filedestructor_adddirnameechoescape_single_quotesfmtFuture_destructorFuture_get_nameFuture_is_settledFuture_racer_destructorFuture_racer_newFuture_racer_nextFutureget_instance_idgetglobimportincludeinitialize_logis_listis_namelengthlenient_modelist_fromlist_is_terminatedlistlog_debuglog_errorlog_infolog_is_levellog_tracelog_warnMap_clearMap_cloneMap_deleteMap_destructorMap_getMap_hasMap_setMap_sizeMap_to_quotedMapmodule_pathmodulenewnsopenOptionsParser_destructorOptionsParser_get_countOptionsParser_has_opt_argOptionsParserpackage_conf_get_boolpackage_conf_get_stringpackage_conf_print_stringpackage_getpackagePipeStatusprocess_runtime_dirprogram_runtime_dirpublicquotereadlinkread_linerealpathrenderroot_packagestart_user_idstrict_modesubstitute_characterssubstitute_expressiontimeoutto_stringtryuser_runtime_diruse_macrovar
Error status codes
1: Expected failure.3:<package>not found.11: Invalid or missing arguments (abort).12: Invalid reference (abort).12: Invalid self reference<&self>(abort).13: Failed to create directory (on initialization) (abort).13: Failed to get user id (on initialization) (abort).13: Unexpected error (on initialization) (abort).14: Base directory missing.15: Failed to create directory.16: Failed to write file (when option-fis used).17: File exists (when option-tis used).18: IFS is null (abort).19: Invalid operand; list items cannot be lists.20: Could not find file at<file>.21: Invalid property value in config file. Expected string but found array.22:<file>is not a symbolic link.23: Any<pathname>failed to resolve.24: No FD available, resource exhausted.25: File exists (when<mode>isw).26: Invalid variable name.122: Some command failed (if fails to retrieve correct status code).123: Unexpected error (abort).123: Unexpected error.